Handle ast.parse failures when converting function type comments #616
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
If we encounter a syntax error in either the type comment extraction or the type comment parsing stages, ignore type information on that cst node.
stroxler
force-pushed
the
handle-syntax-errors
branch
from
3b6cfd1
to
1d620da
Compare
Codecov Report
@@ Coverage Diff @@
## main #616 +/- ##
=======================================
Coverage 94.78% 94.78%
=======================================
Files 245 245
Lines 25238 25250 +12
=======================================
+ Hits 23921 23934 +13
+ Misses 1317 1316 -1
Continue to review full report at Codecov.
|
zsol
approved these changes
Jan 21, 2022
This was referenced Jan 28, 2022
1 task
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
We have to parse code using the ast module in two situations, and in either case we can hit parse errors even though the code is valid python.
(a) by parsing with
type_comments=Trueto reliably extract string type comments from code. This can throw errors if there are comments of the form# type: somethinganywhere where type information is invalid according to PEP 484.(b) by parsing the type comments themselves into expressions or ast.FunctionType values. This can throw errors, even if (a) succeeds, whenever the type itself is not well-formed.
This commit updates
convert_type_commentsto handle these situations by ignoring type information on a specific node - prior to this commit, the entire codemod would have crashed, but there may be many other type comments in the module which are perfectly valid and we'd like to be able to keep going when we hit SyntaxErrors.Test Plan
I added new test cases for invalid type comments